Artemis Product Availability API
Availability Request Overview
Get product availability using the following request resources:
/searchByAddress - Returns product availability for products at an specific address using the following identifiers:
- uprn (Used by City Fibre, Freedom Fibre, Community Fibre and Netomnia to identify an address associated to a premise)
- galk (Used by Openreach to identify an address associated to a premise)
/searchByLine - Returns product availability for products against specific circuit using the following identifiers:
- accessLineId (Line identifer used to determine availability against a specific Openreach Live or Stopped Copper circuit)
- ontReference (Line identifer used to determine availability against a specific Openreach Live or Stopped FTTP circuit)
/searchByReference - Returns product availability for products against specific Live PXC circuit using the following identifiers:
- productId (Product identifier used to identify assets on the PXC Artemis Platform)
- cpwnReference (Product identifier used to identify MPF assets on the PXC OSS Legacy Platform)
- accessCASR (Product identifier used to identify FTTP & SoGEA assets on the PXC SOM1 Platform)
To ensure the correct product variant is returned, the following parameters are required as part of the Product Availability request:
| HTTP Method | Resource | Key | Value(s) | Character Limit | Validation |
|---|---|---|---|---|---|
| GET | /searchByAddress | addressType | GALK, UPRN or GALK-UPRN | 10 | Mandatory |
| GET | /searchByAddress | galk | A00031290370 | 12 | Conditional Mandatory |
| GET | /searchByAddress | uprn | 117084194 | 12 | Conditional Mandatory |
| GET | /searchByAddress | cssDistrictCode | ES | 4 | Conditional Mandatory |
| GET | /searchByAddress | billingAccountId | 12345678 | 8 | Mandatory |
| GET | /searchByAddress | supplierName | Openreach or CityFibre | 20 | Optional |
| GET | /searchByAddress | endCustomerType | Residential or Business | 20 | Mandatory |
| GET | /searchByAddress | serviceType | Managed or Wholesale | 20 | Mandatory |
| GET | /searchByAddress | accessCircuit | FTTP or SOGEA | 20 | Optional |
| GET | /searchByAddress | technology | GPON or VDSL | 20 | Optional |
| GET | /searchByAddress | postcode | M5 3TT | 8 | Conditional Mandatory |
| GET | /searchByAddress | requestedTelephoneNumber | 01612220000 | 12 | Conditional Mandatory |
| GET | /searchByAddress | lcpCupid | 12345 | 10 | Optional |
| HTTP Method | Resource | Key | Value(s) | Character Limit | Validation |
|---|---|---|---|---|---|
| GET | /searchByLine | lineType | ONTRef, AccessLineId or AccessLineId-ONTRef | 20 | Mandatory |
| GET | /searchByLine | accessLineId | OOF5363567O3 | 20 | Conditional Mandatory |
| GET | /searchByLine | ontReference | ONT0000000000 | 20 | Conditional Mandatory |
| GET | /searchByLine | portNumber | 1 | 10 | Conditional Mandatory |
| GET | /searchByLine | billingAccountId | 12345678 | 8 | Mandatory |
| GET | /searchByLine | supplierName | Openreach or CityFibre | 20 | Mandatory |
| GET | /searchByLine | endCustomerType | Residential or Business | 20 | Mandatory |
| GET | /searchByLine | serviceType | Managed or Wholesale | 20 | Mandatory |
| GET | /searchByLine | accessCircuit | FTTP or SOGEA | 20 | Optional |
| GET | /searchByLine | technology | GPON or VDSL | 20 | Optional |
| HTTP Method | Resource | Key | Value(s) | Character Limit | Validation |
|---|---|---|---|---|---|
| GET | /searchByReference | referenceType | cpwnReference, productID or accessCASR | 20 | Mandatory |
| GET | /searchByReference | cpwnReference | 5021111000 | 20 | Conditional Mandatory |
| GET | /searchByReference | productId | 12345678 | 20 | Conditional Mandatory |
| GET | /searchByReference | accessCASR | FTTP123456789 | 20 | Conditional Mandatory |
| GET | /searchByReference | billingAccountId | 12345678 | 8 | Mandatory |
| GET | /searchByReference | endCustomerType | Residential or Business | 20 | Mandatory |
| GET | /searchByReference | serviceType | Managed or Wholesale | 20 | Mandatory |
| GET | /searchByReference | accessCircuit | FTTP or SOGEA | 20 | Optional |
| GET | /searchByReference | technology | GPON or VDSL | 20 | Optional |
Page Version History
| Version | Date last updated | Owner | Description of change |
|---|---|---|---|
| 1.0 | 10/09/2024 | Customer Platforms | Updated key features of Product Availability Experience API |
| 1.1 | 03/06/2025 | Product Delivery | Updated portNumber from optional to conditional mandatory |